billing-prepay-ux

(0 reviews)

TMF654- Group Recurring Charge Estimate

This operation list bucket entities. Attribute selection is enabled for all first level attributes.

URL

https://[localhost]:[port]/billing-prepay-ux/v1/{businessId}/prepayBalanceManagement/bucket

url Param

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.	Y

name	type	description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	Y

Query Param

name	type	description	required
logicalResource.id	number	phone number, Could be different, depending on the use case. For Peacock Mobile Project it's MSISDN	N
partyAccount.id	string	An account or Subscriber id	N

Request to list bucket entities.

Query with ID

curl --location 'https://nonprod.{bgid}.esb.cloud.lla.com/test/billing-prepay-ux-{bgid}/v1/{businessId}/prepayBalanceManagement/bucket' \
--header 'client_id: xxxxxxxxx' \
--header 'client_secret: xxxxxxxxxxx' \
--header 'X-Correlation-ID: {{$guid}}'

Response

[
  {
    "id": "1",
    "name": "Prepaid Balance",
    "@type": "MainBalance",
    "@baseType": "Bucket",
    "description": "United States dollar",
    "usageType": "monetary",
    "isShared": false,
    "remainingValue": {
      "amount": 0,
      "units": "USD"
    },
    "validFor": {
      "startDateTime": "2024-02-21T08:41:02.000000-07:00",
      "endDateTime": "2024-12-31T23:59:59.000000-07:00"
    },
    "relatedParty": [
      {
        "id": "S-103",
        "@type": "SubscriptionRef"
      }
    ],
    "product": [
      {
        "id": "94",
        "name": "Prepaid_Template_Shared",
        "@type": "CatalogRef"
      }
    ],
    "taxItem": [
      {
        "taxAmount": {
          "unit": "USD",
          "value": 3.15
        },
        "taxCategory": "STATE SALES TAX",
        "@type": "TaxItem"
      },
      {
        "taxAmount": {
          "unit": "USD",
          "value": 0.3
        },
        "taxCategory": "CITY SALES TAX",
        "@type": "TaxItem"
      },
      {
        "taxAmount": {
          "unit": "USD",
          "value": 0.5
        },
        "taxCategory": "PR 911 SERVICE CHARGE",
        "@type": "TaxItem"
      },
      {
        "taxAmount": {
          "unit": "USD",
          "value": 0
        },
        "taxCategory": "FEDERAL COST RECOVERY FEE",
        "@type": "TaxItem"
      },
      {
        "taxAmount": {
          "unit": "USD",
          "value": 0
        },
        "taxCategory": "PUERTO RICO REGULATORY FEE",
        "@type": "TaxItem"
      },
      {
        "taxAmount": {
          "unit": "USD",
          "value": 0.27
        },
        "taxCategory": "PR UNIVERSAL SERVICE FUND",
        "@type": "TaxItem"
      },
      {
        "taxAmount": {
          "unit": "USD",
          "value": 0.45
        },
        "taxCategory": "FEDERAL UNIVERSAL SERVICE FUND",
        "@type": "TaxItem"
      },
      {
        "taxAmount": {
          "unit": "USD",
          "value": 0
        },
        "taxCategory": "FEDERAL COST RECOVERY CHARGE",
        "@type": "TaxItem"
      }
    ],
    "impactedAmount": {
      "amount": 33.5,
      "units": "USD"
    }
  },
  {
    "id": "7",
    "name": "Included MMS - Prepaid",
    "@type": "MMS",
    "@baseType": "Bucket",
    "description": "Picture",
    "usageType": "other",
    "isShared": false,
    "remainingValue": {
      "amount": 0,
      "units": "MMS"
    },
    "validFor": {
      "startDateTime": "2024-03-22T00:00:00.000000-06:00",
      "endDateTime": "2024-04-21T00:00:00.000000-06:00"
    },
    "relatedParty": [
      {
        "id": "S-103",
        "@type": "SubscriptionRef"
      }
    ],
    "product": [
      {
        "id": "72",
        "name": "Prepaid_Template_Shared",
        "@type": "CatalogRef"
      }
    ]
  },
  {
    "id": "7",
    "name": "Included Minutes - Prepaid",
    "@baseType": "Bucket",
    "@type": "Voice",
    "description": "Voice",
    "usageType": "voice",
    "isShared": false,
    "remainingValue": {
      "amount": 0,
      "units": "minutes"
    },
    "validFor": {
      "startDateTime": "2024-03-22T00:00:00.000000-06:00",
      "endDateTime": "2024-04-21T00:00:00.000000-06:00"
    },
    "relatedParty": [
      {
        "id": "S-103",
        "@type": "SubscriptionRef"
      }
    ],
    "product": [
      {
        "id": "94",
        "name": "Prepaid_Template_Shared",
        "@type": "CatalogRef"
      }
    ]
  },
  {
    "id": "9",
    "name": "Included SMS - Prepaid",
    "@type": "SMS",
    "@baseType": "Bucket",
    "description": "Text",
    "usageType": "sms",
    "isShared": false,
    "remainingValue": {
      "amount": 0,
      "units": "SMS"
    },
    "validFor": {
      "startDateTime": "2024-03-22T00:00:00.000000-06:00",
      "endDateTime": "2024-04-21T00:00:00.000000-06:00"
    },
    "relatedParty": [
      {
        "id": "S-103",
        "@type": "SubscriptionRef"
      }
    ],
    "product": [
      {
        "id": "94",
        "name": "Prepaid_Template_Shared",
        "@type": "CatalogRef"
      }
    ]
  },
  {
    "id": "6",
    "name": "Flag - Unlimited Hotspot usage",
    "@type": "Flag - Unlimited Hotspot usage",
    "@baseType": "Bucket",
    "description": "Flag",
    "usageType": "other",
    "isShared": false,
    "remainingValue": {
      "amount": 0,
      "units": "none"
    },
    "validFor": {
      "startDateTime": "2024-02-21T08:41:56.000000-07:00",
      "endDateTime": "2024-12-31T23:59:59.000000-07:00"
    },
    "relatedParty": [
      {
        "id": "S-103",
        "@type": "SubscriptionRef"
      }
    ],
    "product": [
      {
        "id": "94",
        "name": "Prepaid_Template_Shared",
        "@type": "CatalogRef"
      }
    ]
  },
  {
    "id": "5",
    "name": "Flag - Unlimited Internet usage",
    "@type": "Flag - Unlimited Internet usage",
    "@baseType": "Bucket",
    "description": "Flag",
    "usageType": "other",
    "isShared": false,
    "remainingValue": {
      "amount": 0,
      "units": "none"
    },
    "validFor": {
      "startDateTime": "2024-02-21T08:41:56.000000-07:00",
      "endDateTime": "2024-12-31T23:59:59.000000-07:00"
    },
    "relatedParty": [
      {
        "id": "S-103",
        "@type": "SubscriptionRef"
      }
    ],
    "product": [
      {
        "id": "94",
        "name": "Prepaid_Template_Shared",
        "@type": "CatalogRef"
      }
    ]
  },
  {
    "id": "11",
    "name": "HotSpot Data - Prepaid",
    "@type": "Data",
    "@baseType": "Bucket",
    "description": "Data",
    "usageType": "data",
    "isShared": false,
    "remainingValue": {
      "amount": 0,
      "units": "mbytes"
    },
    "validFor": {
      "startDateTime": "2024-03-22T00:00:00.000000-06:00",
      "endDateTime": "2024-04-21T00:00:00.000000-06:00"
    },
    "relatedParty": [
      {
        "id": "S-103",
        "@type": "SubscriptionRef"
      }
    ],
    "product": [
      {
        "id": "94",
        "name": "Prepaid_Template_Shared",
        "@type": "CatalogRef"
      }
    ]
  },
  {
    "id": "12",
    "name": "Included Data - Prepaid",
    "@type": "Data",
    "@baseType": "Bucket",
    "description": "Data",
    "usageType": "data",
    "isShared": false,
    "remainingValue": {
      "amount": 0,
      "units": "mbytes"
    },
    "validFor": {
      "startDateTime": "2024-03-22T00:00:00.000000-06:00",
      "endDateTime": "2024-04-21T00:00:00.000000-06:00"
    },
    "relatedParty": [
      {
        "id": "S-103",
        "@type": "SubscriptionRef"
      }
    ],
    "product": [
      {
        "id": "94",
        "name": "Prepaid_Template_Shared",
        "@type": "CatalogRef"
      }
    ]
  },
  {
    "id": "3",
    "name": "Prepaid Group Discount",
    "@type": "Discount",
    "usageType": "monetary",
    "impactedAmount": {
      "amount": -5,
      "units": "USD"
    }
  }
]

Definitions

Each of the response parameters is detailed.

Name	Type	Description	Required
id	string	Resource ID of balance instance.	N
name	string	Name of balance template as defined in My MATRIXX.	N
@type	string	Type.	N
usageType	string	Class name of balance as defined in pricing file.	N
isShared	boolean	Flag mapping: if flag = 1 then `false`; if flag = 2 then `true`.	N
remainingValue	object	Remaining balance details.	N
remainingValue.amount	number	Current balance amount. May not be accurate.	N
remainingValue.units	string	Unit.	N
validFor	object	Validity period details.	N
validFor.endDateTime	datetime	End time of the balance. For a periodic or on-demand balance, it is the end time of the period. For a simple balance, it is the end validity time of the balance.	N
validFor.startDateTime	datetime	Start time of the balance. For a periodic or on-demand balance, it is the start time of the period. For a simple balance, it is the start validity time of the balance.	N
relatedParty	array	Related party details.	N
relatedParty.id	string	External ID of balance owner.	N
relatedParty.@type	string	Reference of Subscription.	N
logicalResource	array	Logical resource details.	N
logicalResource.name	string	Public identifier value of a product.	N
logicalResource.value	string	Public identifier type value.	N
logicalResource.@type	string	Reference of public identifier, such as MSISDN.	N
product	array	Product details.	N
product.id	string	Pricing object ID of catalog item, if applicable.	N
product.name	string	External ID of catalog item, if applicable.	N
product.@type	string	Reference of catalog.	N
bucketCharacteristics	array	Please refer to the Characteristics values section below.	N

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "The request is invalid or not properly formed.",
      "description" : "Malformed request syntax, invalid request message framing, or deceptive request routing."
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource."
    }]
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{
      "code" : 404,
      "message" : "The server could not find the requested resource.",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method PATCH not allowed for : /{businessId}/prepayBalanceManagement/bucket"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "Internal Server Error",
      "description": "The request failed due to an internal error."
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation GET /{businessId}/prepayBalanceManagement/bucket for Business Id: xxxx not implemented"
    }]
  }

#####

#

Reviews